Toot-Info names a function, with lambda list
(TOOT &OPTIONAL
(PRIVATEP (AND *USER* (UUID= (PERSON-UUID *USER*) (TOOT-PLAYER TOOT))))):
Returns a JSON-compatible structure which describes TOOT.
If PRIVATEP, then private information (normally only visible to that
Toot's user) is returned; otherwise, private information is dummied out
or absent.
Also the name of the Toot character, in the form in which it should appear on
an avatar label. Notably, this means that child or sensitive users will have a
black diamond prefixed to the name.
See TOOTSVILLE TOOT-PRESENTATION-NAME
avatar
The base filename of the avatar. The actual URL for the avatar model will
always be
https://jumbo.tootsville.org/Assets/Avatars/5/avatar.babylon.
See TOOTSVILLE TOOT-AVATAR to obtain the avatar's ID, and TOOTSVILLE AVATAR-MONIKER to obtain
the name from that ID.
This is a legacy object which describes the avatar in play, in theory.
It has the following attributes: id, the unique ID for the avatar;
title, always the same as avatar URL base name;
filename, also the same;
forFree, always true; forPaid, always false.
The color for the avatar's pad or “extra” color.
Sent as two identical values.
See TOOTSVILLE TOOT-PAD-COLOR
format
Always the same as avatar now.
colors
The list of base, pattern, and extra color, a third time, as an array-like
object; keys are 0 for base color, 1 for pad color,
and 2 for pattern color.
inRoom
No longer returned; always reads exactly “@Tootsville”
vars
No longer returned; always nil.
clothes
The clothing currently being worn by the character.
For legacy reasons, the character's pattern is repeated here.
Pivitz are considered clothes.
See TOOTSVILLE TOOT-CLOTHES+PATTERN
If there is an active or pending request to play from this child, this object will be attached. It contains uuid, the time the request was placedAt, when it was allowedAt or deniedAt, how long it was allowedFor, and any response text.
childCode
Only available to the user owning the Toot, this is the code to log in as the
child Toot.
See TOOTSVILLE TOOT-CHILD-CODE
The avatarClass object used to have fields s, which is the
same as title; forVIT, which is the same as
forPaid; and avatarClassID, which is the same as
id. The renamed fields were supported under both names in 1.1 or
1.2 based on the setting of the global configuration variable
org.starhope.appius.events.format1.0.
Changes from 1.1 to 1.2
Added scaling for “Magic Toots.”
Changes from 1.2 to 2.0
Added name
Dropped backwards compatibility with the avatarClass object from 1.0
id now returns a UUID, not a fixnum integer.
Avatars are now Babylon 3D models, not Flash objects, and are retrieved from a
different URL pattern.
Prepend black diamonds to userName for children or sensitive users.
Always returns white and black for chatFG and chatBG, as
“Magic Toot” colors are not currently supported in 2.0; they may return in
2.1 or later.
Added baseColor, patternColor, and padColor names in
parallel to existing, now deprecated, colors values.
The avatarClass_B,P,E values, which used to reflect default colors for
an avatar model, are now just the Toot's current colors.
Added uuid, childP, childRequest, sensitiveP,
and lastSeen
When the requestor owns this Toot, added note,
childCode, peanuts, fairyDust,
inRoom always returns “@Tootsville”.
vars always returns nil.
See also Deprecation section below.
Deprecation
The following elements are deprecated and will be removed in a future
revision:
id
use uuid in future.
avatarClass_B,_P,_E and colors
Deprecated in favor of baseColor, patternColor, padColor.
avatarClass
This is deprecated and will be removed in future. Its purpose is
better served by other fields already in the structure.
format
This is deprecated in favor of avatar
Obtaining Toot Information
Avatar information is available through several channels.
/toots/Toot-Name
Fetch only the avatar information for a single Toot from this endpoint